home *** CD-ROM | disk | FTP | other *** search
/ Aminet 12 / Aminet 12 (1996)(GTI - Schatztruhe)[!][Jun 1996].iso / Aminet / dev / misc / XRefInc10.readme < prev   
Encoding:
Text File  |  1996-05-05  |  3.6 KB  |  124 lines
  1. Short:    Generate a reference listing of includes
  2. Author:   i344@stio1.sari.fh-wuerzburg.de (Michael Schettler)
  3. Uploader: i344@stio1.sari.fh-wuerzburg.de
  4. Version:  1.0
  5. Type:     dev/misc
  6. Required: OS 2.04
  7.  
  8. COPYRIGHT
  9.  
  10. The executable and the documentation are copyright 1996 by Michael Schettler.
  11.  
  12.  
  13. INTRODUCTION
  14.  
  15. This is just a small (cli only) tool i hacked together to generate a cross
  16. reference listing of my includes.
  17.  
  18.  
  19. USAGE
  20.  
  21. CLI> xrefinc ?
  22.  
  23.    VS=VSCAN/K/S,DS=DSCAN/K/S,VL=VLIST/K/S,DL=DLIST/K/S,VR=VREFS/K/S,
  24.    DR=DREFS/K/S,SRC=PATH/K,DST=OUTPUT/K,PAT=PATTERN/K,HELP/K/S
  25.  
  26.    VS=VSCAN/K/S    - verbose mode for directory scan
  27.    DS=DSCAN/K/S    - display results of directory scan
  28.    VL=VLIST/K/S    - verbose mode for include list
  29.    DL=DLIST/K/S    - display include list
  30.    VR=VREFS/K/S    - verbose mode for reference list
  31.    DR=DREFS/K/S    - display reference list
  32.    SRC=PATH/K      - where the include files are
  33.    DST=OUTPUT/K    - where to put the reference list
  34.    PAT=PATTERN/K   - filepattern, e.g. only check #?.i
  35.    HELP/K/S        - display a help text
  36.  
  37. Running in verbose mode will display the current filename which is
  38. operated on (large listing, takes a long time ...). The program can be
  39. aborted by pressing 'CTRL-C'.
  40.  
  41. If no arguments are given, the default values will be taken:
  42.  
  43.    DLIST
  44.    DREFS
  45.    SRC   'INCLUDE:'
  46.    DST   standart output
  47.    PAT   '#?.i'
  48.  
  49.  
  50. EXAMPLES
  51.  
  52. Output for argument 'DLIST' (display includes list):
  53.  
  54.    displaying includes tree ...
  55.  
  56.      scanned path 'INCLUDE:'
  57.  
  58.      Filename                       | Includes
  59.      ----------------------------------------------------------------
  60.      exec/ables.i                   | exec/types.i
  61.                     | exec/execbase.i
  62.      ----------------------------------------------------------------
  63.      exec/devices.i                 | exec/libraries.i
  64.                     | exec/ports.i
  65.      ----------------------------------------------------------------
  66.      ...
  67.  
  68.   Which means that the file 'exec/ables.i' includes 'exec/types.i' and
  69.   'exec/execbase.i'.
  70.  
  71.  
  72. Output for argument DREFS (display references list):
  73.  
  74.    displaying references tree ...
  75.  
  76.      scanned path 'INCLUDE:'
  77.  
  78.      Filename                       | Referenced by
  79.      ----------------------------------------------------------------
  80.      exec/ables.i                   | exec/exec.i
  81.      ----------------------------------------------------------------
  82.      exec/exec.i                    | NO REFERENCE!
  83.      ----------------------------------------------------------------
  84.      exec/execbase.i                | exec/ables.i
  85.                     | exec/exec.i
  86.                     | libraries/multiuser.i
  87.      ----------------------------------------------------------------
  88.      ...
  89.  
  90.   Which means that the file 'exec/ables.i' is included by 'exec/exec.i'.
  91.   Getting a 'NO REFERENCE!' means, that this file isn't referenced by
  92.   any other file (simple, eh?)
  93.  
  94.  
  95. AUTHOR
  96.  
  97. You can contact me (bug reports, flames, ...) at
  98.  
  99.     i344@stio1.sari.fh-wuerzburg.de
  100.  
  101.     which is my account at the university, where i study
  102.     computer science
  103.  
  104.     or at
  105.  
  106.     twd@incubus.franken.de
  107.  
  108.     which is my account at my favorite bbs (not so often checked!)
  109.  
  110. If you like to have the source (which is in assembler), you can also
  111. contact me (maybe i'll give it to you, although its a bit of a mess)
  112.  
  113. AMIGA FOREVER!
  114.  
  115.  
  116. ============================= Archive contents =============================
  117.  
  118. Original  Packed Ratio    Date     Time    Name
  119. -------- ------- ----- --------- --------  -------------
  120.     6744    3681 45.4% 01-Feb-96 22:46:00 +XRefInc
  121.     3292    1230 62.6% 01-Feb-96 22:47:34 +XRefInc.readme
  122. -------- ------- ----- --------- --------
  123.    10036    4911 51.0% 28-Apr-96 20:12:18   2 files
  124.